<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos  -->
			<title>Docs For Class renderer</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
						<script src="../media/lib/classTree.js"></script>
												<script language="javascript" type="text/javascript">
				var imgPlus = new Image();
				var imgMinus = new Image();
				imgPlus.src = "../media/images/plus.png";
				imgMinus.src = "../media/images/minus.png";
				
				function showNode(Node){
							switch(navigator.family){
								case 'nn4':
									// Nav 4.x code fork...
							var oTable = document.layers["span" + Node];
							var oImg = document.layers["img" + Node];
									break;
								case 'ie4':
									// IE 4/5 code fork...
							var oTable = document.all["span" + Node];
							var oImg = document.all["img" + Node];
									break;
								case 'gecko':
									// Standards Compliant code fork...
							var oTable = document.getElementById("span" + Node);
							var oImg = document.getElementById("img" + Node);
									break;
							}
					oImg.src = imgMinus.src;
					oTable.style.display = "block";
				}
				
				function hideNode(Node){
							switch(navigator.family){
								case 'nn4':
									// Nav 4.x code fork...
							var oTable = document.layers["span" + Node];
							var oImg = document.layers["img" + Node];
									break;
								case 'ie4':
									// IE 4/5 code fork...
							var oTable = document.all["span" + Node];
							var oImg = document.all["img" + Node];
									break;
								case 'gecko':
									// Standards Compliant code fork...
							var oTable = document.getElementById("span" + Node);
							var oImg = document.getElementById("img" + Node);
									break;
							}
					oImg.src = imgPlus.src;
					oTable.style.display = "none";
				}
				
				function nodeIsVisible(Node){
							switch(navigator.family){
								case 'nn4':
									// Nav 4.x code fork...
							var oTable = document.layers["span" + Node];
									break;
								case 'ie4':
									// IE 4/5 code fork...
							var oTable = document.all["span" + Node];
									break;
								case 'gecko':
									// Standards Compliant code fork...
							var oTable = document.getElementById("span" + Node);
									break;
							}
					return (oTable && oTable.style.display == "block");
				}
				
				function toggleNodeVisibility(Node){
					if (nodeIsVisible(Node)){
						hideNode(Node);
					}else{
						showNode(Node);
					}
				}
			</script>
					</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class renderer</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
							<a href="#sec-descendents">Descendents</a>
			|											<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
						|											<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">A renderer for the xiangqi board</p>
<p class="description"><p>This is the base class for the others</p></p>
		<p class="notes">
			Located in <a class="field" href="_stretchqilib---renderers---renderer.php.html">/stretchqilib/renderers/renderer.php</a> (line <span class="field"><a href="../__filesource/fsource_stretchqi__stretchqilibrenderersrenderer.php.html#a35">35</a></span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>

	<a name="sec-descendents"></a>
	<div class="info-box">
		<div class="info-box-title">Direct descendents</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
			<span class="disabled">Descendents</span>
			|												<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
								|															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
								</div>
		<div class="info-box-body">
			<table cellpadding="2" cellspacing="0" class="class-table">
				<tr>
					<th class="class-table-header">Class</th>
					<th class="class-table-header">Description</th>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../stretchqi/renderer_table.html">renderer_table</a></td>
					<td>
											A table and image based renderer
										</td>
				</tr>
							</table>
		</div>
	</div>


	<a name="sec-var-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Variable Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendents</a> |
						<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
							| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
								</div>
		<div class="info-box-body">
			<div class="var-summary">
																								<div class="var-title">
					<span class="var-type"><a href="../stretchqi/notation.html">object notation</a></span>
					<a href="#$oNotation" title="details" class="var-name">$oNotation</a>
				</div>
											</div>
		</div>
	</div>

	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendents</a> |
																		<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
				 
				|
						<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																														
				<div class="method-definition">
											<span class="method-result">renderer</span>
										<a href="#__construct" title="details" class="method-name">__construct</a>
											(<span class="var-type">array</span>&nbsp;<span class="var-name">$pieceMap</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$sNotationType</span>)
									</div>
														
				<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#getHTML" title="details" class="method-name">getHTML</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#getPieceHTML" title="details" class="method-name">getPieceHTML</a>
											(<span class="var-type"><a href="../stretchqi/pieceinfo.html">object pieceinfo</a></span>&nbsp;<span class="var-name">$oPiece</span>)
									</div>
														
				<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#setPieceMap" title="details" class="method-name">setPieceMap</a>
											(<span class="var-type">array</span>&nbsp;<span class="var-name">$pieceMap</span>)
									</div>
											</div>
		</div>
	</div>		

	<a name="sec-vars"></a>
	<div class="info-box">
		<div class="info-box-title">Variables</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendents</a> |
										<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
						
			
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			
<a name="var$oNotation" id="$oNotation"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type"><a href="../stretchqi/notation.html">object notation</a></span>
			<span class="var-name">$oNotation</span>
			 = <span class="var-default"> null</span>			(line <span class="line-number"><a href="../__filesource/fsource_stretchqi__stretchqilibrenderersrenderer.php.html#a40">40</a></span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	
	
		
		

</div>
						
		</div>
	</div>
	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendents</a> |
															<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
																	<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>
<a name="method__construct" id="__construct"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">Constructor __construct</span> (line <span class="line-number"><a href="../__filesource/fsource_stretchqi__stretchqilibrenderersrenderer.php.html#a46">46</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	
	<div class="method-signature">
		<span class="method-result">renderer</span>
		<span class="method-name">
			__construct
		</span>
					(<span class="var-type">array</span>&nbsp;<span class="var-name">$pieceMap</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$sNotationType</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$pieceMap</span><span class="var-description">: contains object pieceinfo</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$sNotationType</span>			</li>
				</ul>
		
			
	</div>
<a name="methodgetHTML" id="getHTML"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getHTML</span> (line <span class="line-number"><a href="../__filesource/fsource_stretchqi__stretchqilibrenderersrenderer.php.html#a75">75</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">get the html that represents the pieceMap we have been given in the notation we have</p>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			getHTML
		</span>
				()
			</div>
	
		
			
			<hr class="separator" />
		<div class="notes">Redefined in descendants as:</div>
		<ul class="redefinitions">
					<li>
				<a href="../stretchqi/renderer_table.html#methodgetHTML">renderer_table::getHTML()</a>
								: get the html that represents the pieceMap we have been given in the notation we have
							</li>
				</ul>
	</div>
<a name="methodgetPieceHTML" id="getPieceHTML"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getPieceHTML</span> (line <span class="line-number"><a href="../__filesource/fsource_stretchqi__stretchqilibrenderersrenderer.php.html#a66">66</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">get the html that represents the piece</p>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			getPieceHTML
		</span>
					(<span class="var-type"><a href="../stretchqi/pieceinfo.html">object pieceinfo</a></span>&nbsp;<span class="var-name">$oPiece</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"><a href="../stretchqi/pieceinfo.html">object pieceinfo</a></span>
				<span class="var-name">$oPiece</span>			</li>
				</ul>
		
			
			<hr class="separator" />
		<div class="notes">Redefined in descendants as:</div>
		<ul class="redefinitions">
					<li>
				<a href="../stretchqi/renderer_table.html#methodgetPieceHTML">renderer_table::getPieceHTML()</a>
								: get the html that represents the piece
							</li>
					<li>
				<a href="../stretchqi/renderer_text.html#methodgetPieceHTML">renderer_text::getPieceHTML()</a>
								: get the html that represents the piece
							</li>
				</ul>
	</div>
<a name="methodsetPieceMap" id="setPieceMap"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">setPieceMap</span> (line <span class="line-number"><a href="../__filesource/fsource_stretchqi__stretchqilibrenderersrenderer.php.html#a56">56</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">set the array of pieces in their current position</p>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			setPieceMap
		</span>
					(<span class="var-type">array</span>&nbsp;<span class="var-name">$pieceMap</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$pieceMap</span>			</li>
				</ul>
		
			
	</div>
						
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Tue, 12 Jan 2010 10:18:57 +0000 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
	</p>
	</div></body>
</html>